Get Referral Agents
GET /api/v1/users/referral/agents
Description
Retrieve referral agents based on various query parameters.
Path Parameters
| Name | Type | Description |
|---|---|---|
| None | No parameters |
Query Parameters
| Name | Type | Description |
|---|---|---|
userByLocations | string | e.g: longitude,latitude,KM or -40.943,29.2933,10 |
userDateRange | string | e.g: 2020-11-12,2022-11-15 |
userByNinStatus | string | Available values : 0, 1 |
userByBvnStatus | string | Available values : 0, 1 |
userByStatuses | string | Available values : ACTIVE, DISABLE, DEACTIVATE, DELETE |
userByTypes | string | Available values : USER, ADMIN |
userByProfileTenantIds | string | comma separated |
userByWalletAccountOnly | string | e.g: 0 or 1 |
userByWalletAccount | string | |
userByRoles | string | separated by comma any of PLATFORM_GLOBAL,SUPER_ADMIN,ADMIN,TENANT_SUPER_ADMIN,TENANT_GLOBAL,TENANT_ADMIN,TENANT_USER,TENANT_FINANCE,TENANT_BUSINESS,TENANT_OPERATION,TENANT_DEVELOPER,PLATFORM_FINANCE,PLATFORM_BUSINESS,PLATFORM_OPERATION,PLATFORM_DEVELOPER,TRACE_SELLER,TRACE_BUYER,CUSTOMER,BUSINESS,MERCHANT,SUPPLIER,CLIENT,PARTNER,FARMER,DRIVER,AGENCY_BANKING,SABI_AGENT,SABI_OWN,BUSINESS_FINANCE,BUSINESS_AGENT,BUSINESS_OPERATION,BUSINESS_DEVELOPER |
userStaffByTenantIds | string | comma separated |
userByReferralSearch | string | |
userStaffByBusinessIds | string | comma separated |
userByCommodityActiveTraderStatuses | string | comma separated NONE,SELLER,BUYER,BOTH |
userByProfileOwnerIds | string | comma separated |
userByIsManufacturer | string | Available values : 0, 1 |
userByForeignerStatus | string | Available values : 0, 1 |
userByIsDistributor | string | Available values : 0, 1 |
userByPhones | string | |
userByIds | string | |
userFromCensusActive | string | Available values : 0, 1 |
hasWallet | string | Available values : 0, 1 |
userSearch | string | |
order | string | Available values : ASC, DESC |
page | string | |
limit | string |
Example
GET /api/v1/users/referral/agents?userByLocations=-40.943,29.2933,10&userDateRange=2020-11-12,2022-11-15&userByNinStatus=1&userByBvnStatus=1&userByStatuses=ACTIVE&userByTypes=USER&userByProfileTenantIds=tenant123,tenant456&userByWalletAccountOnly=1&userByWalletAccount=&userByRoles=PLATFORM_GLOBAL,ADMIN&userStaffByTenantIds=staff123,staff456&userByReferralSearch=&userStaffByBusinessIds=business123,business456&userByCommodityActiveTraderStatuses=SELLER,BUYER&userByProfileOwnerIds=owner123,owner456&userByIsManufacturer=1&userByForeignerStatus=1&userByIsDistributor=1&userByPhones=&userByIds=&userFromCensusActive=1&hasWallet=1&userSearch=&order=ASC&page=1&limit=10
Response Code: 200 - OK
Description
Successful retrieval of referral agents.
Method: GET
>http://your-api-url/api/v1/users/referral/agents
Headers
| Content-Type | Value |
|---|---|
| apiKey | {{apiKey}} |
LANGUAGE
CURL REQUEST
curl --request GET \
--url /api/v1/users/referral/agents \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!